Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Update Documentation Structure #909

Merged
merged 11 commits into from
Feb 7, 2025
Merged

Conversation

shaneahmed
Copy link
Member

@shaneahmed shaneahmed commented Jan 24, 2025

  • Use Python 3.12 for docs build
  • Update copyright year to 2025
  • Landing page now shows text from README
  • Update documentation structure
  • Update readthedocs Build
  • Remove usage.rst
  • Rename Jupyter Notebooks to Usage Examples
  • Show README for Usage Examples instead of TOC
  • Reduce TOC depth for basic functionalities and pipelines
  • Improve README quality.

@shaneahmed shaneahmed self-assigned this Jan 24, 2025
@shaneahmed shaneahmed added this to the Release v1.7.0 milestone Jan 24, 2025
@shaneahmed shaneahmed added the documentation Improvements or additions to documentation label Jan 24, 2025
Copy link

codecov bot commented Jan 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.90%. Comparing base (d82df5c) to head (ac478d9).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #909   +/-   ##
========================================
  Coverage    99.90%   99.90%           
========================================
  Files           70       70           
  Lines         8735     8735           
  Branches      1149     1149           
========================================
  Hits          8727     8727           
  Misses           3        3           
  Partials         5        5           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@shaneahmed shaneahmed changed the title 📝 Update readthedocs Build 📝 Update readthedocs Structure Feb 7, 2025
@shaneahmed shaneahmed changed the title 📝 Update readthedocs Structure 📝 Update Documentation Structure Feb 7, 2025
@shaneahmed shaneahmed merged commit 264b079 into develop Feb 7, 2025
3 checks passed
@shaneahmed shaneahmed deleted the doc-updatereadthedocs branch February 7, 2025 11:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant